<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>TurBull Encabulator: Encabulator/Encabulator.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo_insert_sml.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">TurBull Encabulator
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('_encabulator_8h_source.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Macros</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">Encabulator.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="_encabulator_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">// ---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">// This software is in the public domain, furnished &quot;as is&quot;, without technical</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">// support, and with no warranty, express or implied, as to its usefulness for</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">// any purpose.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">// Encabulator.h</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">// This is a collection of classes to support the LumiGeek hardware and other </span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment">// sensors on the TurBull Encabulator board</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">// Think of the Encabulator as several Arduino-compatible shields on </span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment">// the same I2C bus on a single circuit board.   </span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment">// Authors: John Parts Taylor and JoeJoe Martin, March 12, 2013</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">// ---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;</div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#ifndef Encabulator_h</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define Encabulator_h</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#include &lt;Arduino.h&gt;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#include &lt;Wire.h&gt;</span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#include &lt;inttypes.h&gt;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;</div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_encabulator_defines_8h.html">EncabulatorDefines.h</a>&quot;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;</div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment">// ---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment">// Abstract Class: LumiGeekShield</span></div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment">// ---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;</div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="code" href="class_lumi_geek_shield.html">   30</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_lumi_geek_shield.html">LumiGeekShield</a></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;{</div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;    <span class="keyword">public</span>:</div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;        <a class="code" href="class_lumi_geek_shield.html#ae301f44e6a4b72596a39d3f5ae775537">LumiGeekShield</a>(uint8_t  i2cAddress);</div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_lumi_geek_shield.html#ae461945c59ef66a5ae2b25ad6dd53ec1">blackout</a>();</div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_lumi_geek_shield.html#ab77ed6f5b84121e07d40242d3416cf51">testPattern</a>();</div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;    <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="code" href="class_lumi_geek_shield.html#a5dc35d651bc8c0030dcb2db7040eb866">   37</a></span>&#160;        <span class="keywordtype">int</span> <a class="code" href="class_lumi_geek_shield.html#a5dc35d651bc8c0030dcb2db7040eb866">_i2cAddress</a>;  <span class="comment">// NOTE: tried to use uint8_t but got an ambiguous compiler error.  Weird.</span></div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;};</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;</div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="comment">// ---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment">// Abstract Class: RGB4XStrip</span></div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="comment">// Since there are two of this shield on the board, this was left abstract.</span></div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="comment">// The subclasses get instantiated with their individual i2c addresseses.</span></div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment">// ---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;</div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="code" href="class_r_g_b4_x_strip.html">   47</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_r_g_b4_x_strip.html">RGB4XStrip</a> : <span class="keyword">public</span> <a class="code" href="class_lumi_geek_shield.html">LumiGeekShield</a></div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;{</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    <span class="keyword">public</span>:</div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="code" href="class_r_g_b4_x_strip.html#af00864017909378272bad2a26b906e01">   50</a></span>&#160;        <a class="code" href="class_r_g_b4_x_strip.html#af00864017909378272bad2a26b906e01">RGB4XStrip</a>(uint8_t addr) : <a class="code" href="class_lumi_geek_shield.html">LumiGeekShield</a>(addr) {</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;            <a class="code" href="class_lumi_geek_shield.html#a5dc35d651bc8c0030dcb2db7040eb866">_i2cAddress</a> = addr;</div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;        };</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_r_g_b4_x_strip.html#a1551f54e863e70035ed4be084d43619c">jumpHeaderToRGB</a>(uint8_t header, uint8_t r, uint8_t g, uint8_t b);</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_r_g_b4_x_strip.html#a4125348542384b5b77bfa199a05b3cc6">fadeHeaderToRGB</a>(uint8_t header, uint8_t r, uint8_t g, uint8_t b, uint8_t speed);</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_r_g_b4_x_strip.html#a0aa612f7e36baf714be9266831cf6042">autoJumpHeaderBetweenRGBs</a>(uint8_t header, uint8_t r1, uint8_t g1, uint8_t b1, uint8_t r2, uint8_t g2, uint8_t b2, uint8_t speed);</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_r_g_b4_x_strip.html#a793cb62c7a39484c311024925ee22c38">autoFadeHeaderBetweenRGBs</a>(uint8_t header, uint8_t r1, uint8_t g1, uint8_t b1, uint8_t r2, uint8_t g2, uint8_t b2, uint8_t speed);</div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_r_g_b4_x_strip.html#aedd7a970d6a437396974bdbab3daddf2">autoFadeHeaderToRandomRGBs</a>(uint8_t header, uint8_t speed);</div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;};</div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;</div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;</div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="comment">// ---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="comment">// Class: RGB4XStripA</span></div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="comment">// For the first 4X shield on the left of the board with headers A1-A4.</span></div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<span class="comment">// The I2C address is hardcoded into the superclass abstract constructor call.</span></div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="comment">// ---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;</div>
<div class="line"><a name="l00067"></a><span class="lineno"><a class="code" href="class_r_g_b4_x_strip_a.html">   67</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_r_g_b4_x_strip_a.html">RGB4XStripA</a> : <span class="keyword">public</span> <a class="code" href="class_r_g_b4_x_strip.html">RGB4XStrip</a></div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;{</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;    <span class="keyword">public</span>:</div>
<div class="line"><a name="l00070"></a><span class="lineno"><a class="code" href="class_r_g_b4_x_strip_a.html#ab5e206f1ea81b3fbf3d5bd534f289147">   70</a></span>&#160;        <a class="code" href="class_r_g_b4_x_strip_a.html#ab5e206f1ea81b3fbf3d5bd534f289147">RGB4XStripA</a>() : <a class="code" href="class_r_g_b4_x_strip.html">RGB4XStrip</a>(<a class="code" href="_encabulator_defines_8h.html#aff295912448a376ec141f6773c63e482">LG_RGB_4X_A</a>) {};</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;};</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="comment">// ---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="comment">// Class: RGB4XStripB</span></div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="comment">// For the second 4X shield on the left of the board with headers B1-B4.</span></div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;<span class="comment">// The I2C address is hardcoded into the superclass abstract constructor call.</span></div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;<span class="comment">// ---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;</div>
<div class="line"><a name="l00080"></a><span class="lineno"><a class="code" href="class_r_g_b4_x_strip_b.html">   80</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_r_g_b4_x_strip_b.html">RGB4XStripB</a> : <span class="keyword">public</span> <a class="code" href="class_r_g_b4_x_strip.html">RGB4XStrip</a></div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;{</div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;    <span class="keyword">public</span>:</div>
<div class="line"><a name="l00083"></a><span class="lineno"><a class="code" href="class_r_g_b4_x_strip_b.html#ae1ea6c69ba68999408d841908d3895cc">   83</a></span>&#160;        <a class="code" href="class_r_g_b4_x_strip_b.html#ae1ea6c69ba68999408d841908d3895cc">RGB4XStripB</a>() : <a class="code" href="class_r_g_b4_x_strip.html">RGB4XStrip</a>(<a class="code" href="_encabulator_defines_8h.html#ab6a434e4dd6e71bc0d5add2b85f41764">LG_RGB_4X_B</a>) {};</div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;};</div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;</div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;</div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="comment">// ---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="comment">// Class: Addr1XMultiTool</span></div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<span class="comment">// Used to control various types of Addressable LED products.  See defines file. </span></div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;<span class="comment">// The I2C address is hardcoded into the abstract superclass constructor call.</span></div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;<span class="comment">// Since this is a 1X board, the header parameter is ommitted from these helper methods</span></div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;<span class="comment">// ---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;</div>
<div class="line"><a name="l00094"></a><span class="lineno"><a class="code" href="class_addr1_x_multi_tool.html">   94</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_addr1_x_multi_tool.html">Addr1XMultiTool</a> : <span class="keyword">public</span> <a class="code" href="class_lumi_geek_shield.html">LumiGeekShield</a></div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;{</div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;    <span class="keyword">public</span>:</div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;    <span class="comment">//  Addr1XMultiTool() : LumiGeekShield(LG_ADDR_1X) {};</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"><a class="code" href="class_addr1_x_multi_tool.html#a873dd54abffa56519a5e00cadba0272c">   98</a></span>&#160;        <a class="code" href="class_addr1_x_multi_tool.html#a873dd54abffa56519a5e00cadba0272c">Addr1XMultiTool</a>() : <a class="code" href="class_lumi_geek_shield.html">LumiGeekShield</a>(0x54) {};</div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_addr1_x_multi_tool.html#ad0bc81669fb16081008053bae204a8b0">setMode</a>(uint8_t mode);</div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_addr1_x_multi_tool.html#afba934b57f94482ce02c61845827ede2">drawGradient</a>(uint8_t r1, uint8_t g1, uint8_t b1, uint8_t r2, uint8_t g2, uint8_t b2, uint8_t length);</div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_addr1_x_multi_tool.html#ac828bc68580ea083b21295c9d2766952">drawComet</a>(uint8_t r, uint8_t g, uint8_t b, uint8_t cometLength, uint8_t tailLength, uint8_t speed);</div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_addr1_x_multi_tool.html#a32a043245dbc357c0a60e5ac60b53fbf">drawFrame</a>(uint8_t pixelCount, uint8_t pixelRGBs[]);</div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_addr1_x_multi_tool.html#a441d99fab2fd84ac05e16c54402567f8">shiftBufferOnce</a>(uint8_t direction, uint8_t length);</div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_addr1_x_multi_tool.html#a4155084065b69aed14caff11d039940d">autoShiftBuffer</a>(uint8_t direction, uint8_t length, uint8_t speed);</div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;};</div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;</div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;</div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;<span class="comment">// ---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;<span class="comment">// Class: DMX1XUniverse</span></div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;<span class="comment">// Used to generate and repeatedly transmit a DMX universe framebuffer.</span></div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;<span class="comment">// The I2C address is hardcoded into the abstract superclass constructor call.</span></div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;<span class="comment">// Since this is a 1X board, the header parameter is ommitted from these helper methods.</span></div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;<span class="comment">// ---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;</div>
<div class="line"><a name="l00115"></a><span class="lineno"><a class="code" href="class_d_m_x1_x_universe.html">  115</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_d_m_x1_x_universe.html">DMX1XUniverse</a> : <span class="keyword">public</span> <a class="code" href="class_lumi_geek_shield.html">LumiGeekShield</a></div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;{</div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;    <span class="keyword">public</span>:</div>
<div class="line"><a name="l00118"></a><span class="lineno"><a class="code" href="class_d_m_x1_x_universe.html#aa953af91256b814e80c55f3ee602ad10">  118</a></span>&#160;        <a class="code" href="class_d_m_x1_x_universe.html#aa953af91256b814e80c55f3ee602ad10">DMX1XUniverse</a>() : <a class="code" href="class_lumi_geek_shield.html">LumiGeekShield</a>(<a class="code" href="_encabulator_defines_8h.html#ac8c87bb4cb633be6ec0587b4e1cafcc8">LG_DMX_1X</a>) {};</div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_d_m_x1_x_universe.html#a320af44f45d53f0db74873b538048260">setDataFromAddressWithRGB</a>(uint8_t address, uint8_t r, uint8_t g, uint8_t b);</div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_d_m_x1_x_universe.html#ae9fe2f13053eb8763da478981b0ab15a">setEntireUniverse</a>(uint8_t universe[]);</div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;};</div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;</div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;</div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;<span class="comment">// ---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;<span class="comment">// Class: XYZHelper</span></div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;<span class="comment">// This is a rudiemntary helper class for the KXTI9-1001 accelerometer by Kionix.</span></div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;<span class="comment">// It is initialized with a call to begin().  </span></div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;<span class="comment">// Calling updateValues() will fetch the twos-compliment of the raw x, y,and z values</span></div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;<span class="comment">// This is a very robust accelerometer chip and direct I2C calls can access features</span></div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;<span class="comment">// such as tap-detection and filtering that are not exposed in this simple helper class.</span></div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;<span class="comment">// ---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;</div>
<div class="line"><a name="l00133"></a><span class="lineno"><a class="code" href="class_x_y_z_helper.html">  133</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_x_y_z_helper.html">XYZHelper</a></div>
<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;{</div>
<div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;    <span class="keyword">private</span>:</div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;        int16_t _x;</div>
<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;        int16_t _y;</div>
<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;        int16_t _z;</div>
<div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;        <span class="keywordtype">bool</span> _initialized;</div>
<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;    <span class="keyword">protected</span>: </div>
<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_x_y_z_helper.html#aa1fd5787ab66b7b4c4e15ee486c2e0e1">writeRegister</a>(uint8_t reg, uint8_t data);</div>
<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;        uint8_t <a class="code" href="class_x_y_z_helper.html#a4957919bcb6c7d94d2028a6c5f1d057f">readRegister</a>(uint8_t reg);</div>
<div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;        int16_t <a class="code" href="class_x_y_z_helper.html#a4289eb5bb1a391484ad20d3ebeaf647a">combineBytes</a>(uint8_t tempLow, uint8_t tempHigh);</div>
<div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;    <span class="keyword">public</span>:</div>
<div class="line"><a name="l00145"></a><span class="lineno"><a class="code" href="class_x_y_z_helper.html#ae31ed736235e124ca9ade8082664ae06">  145</a></span>&#160;        <a class="code" href="class_x_y_z_helper.html#ae31ed736235e124ca9ade8082664ae06">XYZHelper</a>() {</div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;            _initialized = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;        };</div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_x_y_z_helper.html#ab45c8ea6cd2de63510b578de56e9e545">begin</a>();</div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_x_y_z_helper.html#a9e3ecbece20bcff51ada3a845847e919">update</a>();</div>
<div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;        int16_t <a class="code" href="class_x_y_z_helper.html#ae19ef3f7024d64a616e10ed864fee605">x</a>();</div>
<div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;        int16_t <a class="code" href="class_x_y_z_helper.html#a52081fa66ae74fed31ce163a89bf99f0">y</a>();</div>
<div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;        int16_t <a class="code" href="class_x_y_z_helper.html#a20fbd64cf8b59f4df581f074eac11065">z</a>();</div>
<div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;};</div>
<div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;</div>
<div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;</div>
<div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;<span class="comment">// ---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;<span class="comment">// Class: DACHelper</span></div>
<div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;<span class="comment">// Helper class to send a 12-bit value to an MCP4725 DAC by Microchip.  </span></div>
<div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;<span class="comment">// The I2C address of the DAC hardcoded into the abstract superclass constructor call.</span></div>
<div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;<span class="comment">// ---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;</div>
<div class="line"><a name="l00162"></a><span class="lineno"><a class="code" href="class_d_a_c_helper.html">  162</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_d_a_c_helper.html">DACHelper</a></div>
<div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;{</div>
<div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;    <span class="keyword">public</span>:</div>
<div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_d_a_c_helper.html#ad640274b3b1165a8034346b857758e99">write</a>(uint16_t value);</div>
<div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;};</div>
<div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;</div>
<div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;</div>
<div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;<span class="comment">// ---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;<span class="comment">// Class: TemperatureHelper</span></div>
<div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;<span class="comment">// Helper class to get a 13-bit temperature value from the ADT7410 by Analog Devices</span></div>
<div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;<span class="comment">// The I2C address of the temperature sensor is hardcoded into the abstract superclass constructor call.</span></div>
<div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;<span class="comment">// ---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;</div>
<div class="line"><a name="l00175"></a><span class="lineno"><a class="code" href="class_temperature_helper.html">  175</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_temperature_helper.html">TemperatureHelper</a> </div>
<div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;{</div>
<div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;    <span class="keyword">public</span>:</div>
<div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;        <span class="keywordtype">float</span> <a class="code" href="class_temperature_helper.html#acd09bbef74b50bae62da22f5e112ce59">getCelsius</a>();</div>
<div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;};</div>
<div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;</div>
<div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;</div>
<div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;<span class="comment">// ---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;<span class="comment">// Class: EEPROMHelper</span></div>
<div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;<span class="comment">// Rudimentary helper class to read and write bytes to persistent memory with the 24LC512 by Microchip.</span></div>
<div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;<span class="comment">// There are more advanced libraries and/or sample code for this EEPROM that support pages and more.</span></div>
<div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;<span class="comment">// The I2C address of the EEPROM is hardcoded into the abstract superclass constructor call.</span></div>
<div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;<span class="comment">// ---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;</div>
<div class="line"><a name="l00189"></a><span class="lineno"><a class="code" href="class_e_e_p_r_o_m_helper.html">  189</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_e_e_p_r_o_m_helper.html">EEPROMHelper</a></div>
<div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;{</div>
<div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;    <span class="keyword">public</span>:</div>
<div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;        uint8_t <a class="code" href="class_e_e_p_r_o_m_helper.html#aa7fb0c00c24d5b88fd005533295d9045">writeAddress</a>(uint16_t address, uint8_t byte);</div>
<div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;        uint8_t <a class="code" href="class_e_e_p_r_o_m_helper.html#a0f381faafe19016478710657e437d9fc">readAddress</a>(uint16_t address);</div>
<div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;};</div>
<div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;</div>
<div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;</div>
<div class="line"><a name="l00197"></a><span class="lineno">  197</span>&#160;<span class="comment">// ---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;<span class="comment">// Class: TurBullEncabulator</span></div>
<div class="line"><a name="l00199"></a><span class="lineno">  199</span>&#160;<span class="comment">// One shield to rule them all!!!</span></div>
<div class="line"><a name="l00200"></a><span class="lineno">  200</span>&#160;<span class="comment">// ---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00201"></a><span class="lineno">  201</span>&#160;</div>
<div class="line"><a name="l00202"></a><span class="lineno"><a class="code" href="class_tur_bull_encabulator.html">  202</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_tur_bull_encabulator.html">TurBullEncabulator</a> </div>
<div class="line"><a name="l00203"></a><span class="lineno">  203</span>&#160;{</div>
<div class="line"><a name="l00204"></a><span class="lineno">  204</span>&#160;    <span class="keyword">private</span>:</div>
<div class="line"><a name="l00205"></a><span class="lineno">  205</span>&#160;        <span class="keyword">static</span> <span class="keywordtype">bool</span> _verbose;</div>
<div class="line"><a name="l00206"></a><span class="lineno">  206</span>&#160;    <span class="keyword">public</span>: </div>
<div class="line"><a name="l00207"></a><span class="lineno"><a class="code" href="class_tur_bull_encabulator.html#a1bc1de92c7929c9d9148c9fbf6c61d9a">  207</a></span>&#160;        <a class="code" href="class_d_a_c_helper.html">DACHelper</a> <a class="code" href="class_tur_bull_encabulator.html#a1bc1de92c7929c9d9148c9fbf6c61d9a">dac</a>;</div>
<div class="line"><a name="l00208"></a><span class="lineno"><a class="code" href="class_tur_bull_encabulator.html#a28d63a77a1e2a1d96d2fe3ff94a4d41b">  208</a></span>&#160;        <a class="code" href="class_x_y_z_helper.html">XYZHelper</a> <a class="code" href="class_tur_bull_encabulator.html#a28d63a77a1e2a1d96d2fe3ff94a4d41b">accelerometer</a>;</div>
<div class="line"><a name="l00209"></a><span class="lineno"><a class="code" href="class_tur_bull_encabulator.html#a1b81bd1b9aab24b150a8659220894b3b">  209</a></span>&#160;        <a class="code" href="class_temperature_helper.html">TemperatureHelper</a> <a class="code" href="class_tur_bull_encabulator.html#a1b81bd1b9aab24b150a8659220894b3b">temperature</a>;</div>
<div class="line"><a name="l00210"></a><span class="lineno"><a class="code" href="class_tur_bull_encabulator.html#ac4304f6a95aa1f5f3ed1ae621d669676">  210</a></span>&#160;        <a class="code" href="class_e_e_p_r_o_m_helper.html">EEPROMHelper</a> <a class="code" href="class_tur_bull_encabulator.html#ac4304f6a95aa1f5f3ed1ae621d669676">eeprom</a>;</div>
<div class="line"><a name="l00211"></a><span class="lineno">  211</span>&#160;        </div>
<div class="line"><a name="l00212"></a><span class="lineno"><a class="code" href="class_tur_bull_encabulator.html#a62c47f785987a0f87592b86ddb7d7698">  212</a></span>&#160;        <a class="code" href="class_addr1_x_multi_tool.html">Addr1XMultiTool</a> <a class="code" href="class_tur_bull_encabulator.html#a62c47f785987a0f87592b86ddb7d7698">addressable</a>;</div>
<div class="line"><a name="l00213"></a><span class="lineno"><a class="code" href="class_tur_bull_encabulator.html#adbcb69c440e8906436c81a48aab31a4a">  213</a></span>&#160;        <a class="code" href="class_d_m_x1_x_universe.html">DMX1XUniverse</a> <a class="code" href="class_tur_bull_encabulator.html#adbcb69c440e8906436c81a48aab31a4a">dmx</a>;</div>
<div class="line"><a name="l00214"></a><span class="lineno"><a class="code" href="class_tur_bull_encabulator.html#a734c04c6c840e1177abfe10639f692eb">  214</a></span>&#160;        <a class="code" href="class_r_g_b4_x_strip_a.html">RGB4XStripA</a> <a class="code" href="class_tur_bull_encabulator.html#a734c04c6c840e1177abfe10639f692eb">stripBankA</a>;</div>
<div class="line"><a name="l00215"></a><span class="lineno"><a class="code" href="class_tur_bull_encabulator.html#a1a539710094a7c0f646ecb2e6c3c357b">  215</a></span>&#160;        <a class="code" href="class_r_g_b4_x_strip_b.html">RGB4XStripB</a> <a class="code" href="class_tur_bull_encabulator.html#a1a539710094a7c0f646ecb2e6c3c357b">stripBankB</a>;     </div>
<div class="line"><a name="l00216"></a><span class="lineno">  216</span>&#160;        </div>
<div class="line"><a name="l00217"></a><span class="lineno">  217</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_tur_bull_encabulator.html#aa3323360878f0b88da975600ca8a31b3">upUpDownDownLeftRightLeftRightBA</a>();</div>
<div class="line"><a name="l00218"></a><span class="lineno">  218</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_tur_bull_encabulator.html#ae1ebd5a1f84087833257618885c1ac5e">setVerbose</a>(<span class="keywordtype">bool</span> b);</div>
<div class="line"><a name="l00219"></a><span class="lineno">  219</span>&#160;        </div>
<div class="line"><a name="l00220"></a><span class="lineno">  220</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_tur_bull_encabulator.html#a237c00632ac25e60f09a6c349860b110">testPattern</a>();</div>
<div class="line"><a name="l00221"></a><span class="lineno">  221</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_tur_bull_encabulator.html#a9078459a2a063a68f497b8db82d2c616">blackout</a>();</div>
<div class="line"><a name="l00222"></a><span class="lineno">  222</span>&#160;};</div>
<div class="line"><a name="l00223"></a><span class="lineno">  223</span>&#160;</div>
<div class="line"><a name="l00224"></a><span class="lineno">  224</span>&#160;</div>
<div class="line"><a name="l00225"></a><span class="lineno">  225</span>&#160;<span class="keyword">extern</span> <a class="code" href="class_tur_bull_encabulator.html">TurBullEncabulator</a> <a class="code" href="_encabulator_8cpp.html#a3593d78e907aec8468f10d505fe0a914">Encabulator</a>;</div>
<div class="line"><a name="l00226"></a><span class="lineno">  226</span>&#160;</div>
<div class="line"><a name="l00227"></a><span class="lineno">  227</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_35baefe986baf201b5ed1727c8e46b3c.html">Encabulator</a></li><li class="navelem"><a class="el" href="_encabulator_8h.html">Encabulator.h</a></li>
    <li class="footer">Generated on Thu Mar 21 2013 02:24:59 for TurBull Encabulator by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3.1 </li>
  </ul>
</div>
</body>
</html>
